Tootsville-User::Doc

Function

Doc names a function, with lambda list (&REST WORDS):

Obtain documentation string in raw form about a symbol.

Usage

#doc [PACKAGE] SYMBOL [TYPE]

TYPE can be VARIABLE, FUNCTION, STRUCTURE, TYPE, SETF, or T. If not supplied, defaults to FUNCTION.

PACKAGE is optional and defaults to TOOTSVILLE-USER.

Examples

#doc cdr #doc doc function #doc Tootsville ws-stats #doc Tootsville ws-bandwidth-by-source function

This is based upon DOCUMENTATION (see the Common Lisp HyperSpec), qv.

File

Defined in file src/infinity/modern-ops.lisp.